home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 October: Mac OS SDK / Dev.CD Oct 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / OSA.a < prev    next >
Encoding:
Text File  |  1997-08-12  |  57.6 KB  |  1,831 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        OSA.a
  3. ;
  4. ;    Contains:    AppleScript Client Interfaces.
  5. ;
  6. ;    Version:    Technology:    AppleScript 1.1
  7. ;                Release:    Universal Interfaces 3.0.1
  8. ;
  9. ;    Copyright:    © 1992-1997 by Apple Computer, Inc., all rights reserved
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__OSA__') = 'UNDEFINED' THEN
  19. __OSA__ SET 1
  20.  
  21.     IF &TYPE('__ERRORS__') = 'UNDEFINED' THEN
  22.     include 'Errors.a'
  23.     ENDIF
  24.     IF &TYPE('__APPLEEVENTS__') = 'UNDEFINED' THEN
  25.     include 'AppleEvents.a'
  26.     ENDIF
  27.     IF &TYPE('__AEOBJECTS__') = 'UNDEFINED' THEN
  28.     include 'AEObjects.a'
  29.     ENDIF
  30.     IF &TYPE('__COMPONENTS__') = 'UNDEFINED' THEN
  31.     include 'Components.a'
  32.     ENDIF
  33.  
  34. ; **************************************************************************
  35. ;    Types and Constants
  36. ;*************************************************************************
  37.  
  38.  
  39. ;     The componenent manager type code for components that
  40. ;        support the OSA interface defined here. 
  41. ;  0x6f736120 
  42.  
  43. kOSAComponentType                EQU        'osa '
  44. ;  0x73637074 
  45.  
  46. kOSAGenericScriptingComponentSubtype EQU 'scpt'
  47. ;     Type of script document files.    
  48. ;  0x6f736173 
  49.  
  50. kOSAFileType                    EQU        'osas'
  51. ; 
  52. ;        Suite and event code of the RecordedText event. 
  53. ;        (See OSAStartRecording, below.)
  54. ;    
  55.  
  56. ;  0x61736372 
  57.  
  58. kOSASuite                        EQU        'ascr'
  59. ;  0x72656364 
  60.  
  61. kOSARecordedText                EQU        'recd'
  62. ;  Selector returns boolean 
  63. ;  0x6d6f6469 
  64.  
  65. kOSAScriptIsModified            EQU        'modi'
  66. ;  Selector returns boolean 
  67. ;  0x63736372 
  68.  
  69. kOSAScriptIsTypeCompiledScript    EQU        'cscr'
  70. ;  Selector returns boolean 
  71. ;  0x76616c75 
  72.  
  73. kOSAScriptIsTypeScriptValue        EQU        'valu'
  74. ;  Selector returns boolean 
  75. ;  0x636e7478 
  76.  
  77. kOSAScriptIsTypeScriptContext    EQU        'cntx'
  78. ;  Selector returns a DescType which may be passed to OSACoerceToDesc 
  79. ;  0x62657374 
  80.  
  81. kOSAScriptBestType                EQU        'best'
  82. ; 
  83. ;        This selector is used to determine whether a script has source 
  84. ;        associated with it that when given to OSAGetSource, the call will not
  85. ;        fail.  The selector returns a boolean.
  86. ;    
  87.  
  88. ;  0x67737263 
  89.  
  90. kOSACanGetSource                EQU        'gsrc'
  91.  
  92.  
  93. typeOSADialectInfo                EQU        'difo'                ;  0x6469666f   
  94. keyOSADialectName                EQU        'dnam'                ;  0x646e616d   
  95. keyOSADialectCode                EQU        'dcod'                ;  0x64636f64   
  96. keyOSADialectLangCode            EQU        'dlcd'                ;  0x646c6364   
  97. keyOSADialectScriptCode            EQU        'dscd'                ;  0x64736364   
  98. ; typedef ComponentResult                 OSAError
  99.  
  100. ;  Under the Open Scripting Architecture all error results are longs 
  101. ; typedef unsigned long                 OSAID
  102.  
  103. ; 
  104. ;        OSAIDs allow transparent manipulation of scripts associated with
  105. ;         various scripting systems.
  106. ;    
  107.  
  108.  
  109. kOSANullScript                    EQU        0
  110. ;  No -script constant. 
  111.  
  112. kOSANullMode                    EQU        0                    ; sounds better 
  113. kOSAModeNull                    EQU        0                    ; tastes consistent 
  114. ; 
  115. ;        Some routines take flags that control their execution.  This constant
  116. ;        declares default mode settings are used.
  117. ;    
  118.  
  119. ; **************************************************************************
  120. ;    Standard Script Errors
  121. ;**************************************************************************
  122. ;    It is recommended that scripting components use the following set of error
  123. ;    codes to signal failure when applicable.  This enables applications that
  124. ;    use the OSA API to deal with some class of script errors in a less than 
  125. ;    ad hoc manner.  Scripting components are of course encouraged to return
  126. ;    component-specific errors when these don't apply.
  127. ;*************************************************************************
  128.  
  129. ;         Dynamic errors:
  130. ;
  131. ;    These errors result from data-dependent conditions and are typically
  132. ;    signaled at runtime.
  133. ;
  134.  
  135. ; 
  136. ;        Signaled when a value can't be coerced to the desired type. Similar
  137. ;          to errOSATypeError except results from coercion.
  138. ;    
  139.  
  140.  
  141. errOSACantCoerce                EQU        -1700
  142. ;  Signaled when an object is not found in a container 
  143.  
  144. errOSACantAccess                EQU        -1728
  145. ; 
  146. ;        Signaled when an object cannot be set in a container.  Same as 
  147. ;          AERegistry error errAEWriteDenied.
  148. ;    
  149.  
  150.  
  151. errOSACantAssign                EQU        -10006
  152. ; 
  153. ;        Signaled by user scripts or applications when no actual error code
  154. ;          is to be returned.  Simply means "an error has occurred".  Most useful
  155. ;          in conjunction with an error message from the application.
  156. ;    
  157.  
  158.  
  159. errOSAGeneralError                EQU        -2700
  160. ;  Signaled when there is an attempt to divide by zero 
  161.  
  162. errOSADivideByZero                EQU        -2701
  163. ;  Signaled when integer or real value is too large to be represented 
  164.  
  165. errOSANumericOverflow            EQU        -2702
  166. ; 
  167. ;        Signaled when application can't be launched or when it is remote and
  168. ;          program linking is not enabled.
  169. ;    
  170.  
  171.  
  172. errOSACantLaunch                EQU        -2703
  173. ;  Signaled when an application can't respond to AppleEvents 
  174.  
  175. errOSAAppNotHighLevelEventAware    EQU        -2704
  176. ;  Signaled when an application's terminology resource is not readable 
  177.  
  178. errOSACorruptTerminology        EQU        -2705
  179. ;  Signaled when the runtime stack overflows 
  180.  
  181. errOSAStackOverflow                EQU        -2706
  182. ;  Signaled when a runtime internal data structure overflows 
  183.  
  184. errOSAInternalTableOverflow        EQU        -2707
  185. ; 
  186. ;        Signaled when an intrinsic limitation is exceeded for the size of 
  187. ;          a value or data structure.
  188. ;    
  189.  
  190.  
  191. errOSADataBlockTooLarge            EQU        -2708
  192.  
  193. errOSACantGetTerminology        EQU        -2709
  194.  
  195. errOSACantCreate                EQU        -2710
  196. ;         Component-specific dynamic script errors:
  197. ;
  198. ;    The range -2720 thru -2739 is reserved for component-specific runtime errors.
  199. ;    (Note that error codes from different scripting components in this range will
  200. ;    overlap.)
  201. ;
  202.  
  203. ;         Static errors:
  204. ;
  205. ;    These errors comprise what are commonly thought of as parse and compile-
  206. ;    time errors.  However, in a dynamic system (e.g. AppleScript) any or all
  207. ;    of these may also occur at runtime.
  208. ;
  209.  
  210.  
  211. ;  Signaled when data was not the right type and coercion is not allowed 
  212.  
  213. errOSATypeError                    EQU        -1703
  214. ;  Signaled when a message was sent to an object that didn't handle it 
  215.  
  216. OSAMessageNotUnderstood            EQU        -1708
  217. ; 
  218. ;        Signaled when a function to be returned doesn't exist.  (Probably only
  219. ;          useful in languages with first-class functions that distinguish between
  220. ;          functions and other values (two name spaces). This is different from
  221. ;          errOSAMessageNotUnderstood, which may be signaled when the method is
  222. ;          invoked.
  223. ;    
  224.  
  225.  
  226. OSAUndefinedHandler                EQU        -1717
  227. ;  Signaled when a container can never have the requested object 
  228.  
  229. OSAIllegalAccess                EQU        -1723
  230. ;  Signaled when index was out of range. Specialization of errOSACantAccess. 
  231.  
  232. OSAIllegalIndex                    EQU        -1719
  233. ;  Signaled when a range is screwy. Specialization of errOSACantAccess. 
  234.  
  235. OSAIllegalRange                    EQU        -1720
  236. ; 
  237. ;        Signaled when an object can never be set in a container.  Same as 
  238. ;          AERegistry error errAENotModifiable.
  239. ;    
  240.  
  241.  
  242. OSAIllegalAssign                EQU        -10003
  243. ; 
  244. ;        Signaled when a syntax error occurs. (e.g. "Syntax error" or
  245. ;         "<this> can't go after <that>").
  246. ;    
  247.  
  248.  
  249. OSASyntaxError                    EQU        -2740
  250. ; 
  251. ;        Signaled when another form of syntax was expected. (e.g. "expected
  252. ;          a <type> but found <this>").
  253. ;    
  254.  
  255.  
  256. OSASyntaxTypeError                EQU        -2741
  257. ;  Signaled when a name or number is too long to be parsed 
  258.  
  259. OSATokenTooLong                    EQU        -2742
  260. ; 
  261. ;        Signaled when a parameter is missing for a function invocation.  Note
  262. ;          that in some languages, this error may occur at runtime.
  263. ;    
  264.  
  265.  
  266. OSAMissingParameter                EQU        -1701
  267. ; 
  268. ;        Signaled when function is called with the wrong number of parameters,
  269. ;          or a parameter pattern cannot be matched.
  270. ;    
  271.  
  272.  
  273. OSAParameterMismatch            EQU        -1721
  274. ; 
  275. ;        Signaled when a formal parameter, local variable, or instance variable
  276. ;          is specified more than once.
  277. ;    
  278.  
  279.  
  280. OSADuplicateParameter            EQU        -2750
  281. ; 
  282. ;        Signaled when a formal parameter, local variable, or instance variable
  283. ;          is specified more than once.
  284. ;    
  285.  
  286.  
  287. OSADuplicateProperty            EQU        -2751
  288. ; 
  289. ;        Signaled when more than one handler is defined with the same name in 
  290. ;          a scope where the language doesn't allow it.
  291. ;    
  292.  
  293.  
  294. OSADuplicateHandler                EQU        -2752
  295. ;  Signaled when a variable is accessed that has no value 
  296.  
  297. OSAUndefinedVariable            EQU        -2753
  298. ; 
  299. ;        Signaled when a variable is declared inconsistently in the same scope,
  300. ;          such as both local and global.
  301. ;    
  302.  
  303.  
  304. OSAInconsistentDeclarations        EQU        -2754
  305. ; 
  306. ;        Signaled when illegal control flow occurs in an application (no catcher
  307. ;          for throw, non-lexical loop exit, etc.).
  308. ;    
  309.  
  310.  
  311. OSAControlFlowError                EQU        -2755
  312. ;         Component-specific static script errors:
  313. ;
  314. ;    The range -2760 thru -2779 is reserved for component-specific parsing and
  315. ;    compile-time errors. (Note that error codes from different scripting
  316. ;    components in this range will overlap.)
  317. ;
  318.  
  319. ;         Dialect-specific script errors:
  320. ;
  321. ;    The range -2780 thru -2799 is reserved for dialect specific error codes for
  322. ;    scripting components that support dialects. (Note that error codes from
  323. ;    different scripting components in this range will overlap, as well as error
  324. ;    codes from different dialects in the same scripting component.)
  325. ;
  326.  
  327. ; **************************************************************************
  328. ;    OSA Interface Descriptions
  329. ;**************************************************************************
  330. ;    The OSA Interface is broken down into a required interface, and several
  331. ;    optional interfaces to support additional functionality.  A given scripting
  332. ;    component may choose to support only some of the optional interfaces in
  333. ;    addition to the basic interface.  The OSA Component Flags may be used to 
  334. ;    query the Component Manager to find a scripting component with a particular
  335. ;    capability, or determine if a particular scripting component supports a 
  336. ;    particular capability.
  337. ;*************************************************************************
  338.  
  339. ;  OSA Component Flags: 
  340.  
  341. kOSASupportsCompiling            EQU        $0002
  342. kOSASupportsGetSource            EQU        $0004
  343. kOSASupportsAECoercion            EQU        $0008
  344. kOSASupportsAESending            EQU        $0010
  345. kOSASupportsRecording            EQU        $0020
  346. kOSASupportsConvenience            EQU        $0040
  347. kOSASupportsDialects            EQU        $0080
  348. kOSASupportsEventHandling        EQU        $0100
  349. ;  Component Selectors: 
  350.  
  351. kOSASelectLoad                    EQU        $0001
  352. kOSASelectStore                    EQU        $0002
  353. kOSASelectExecute                EQU        $0003
  354. kOSASelectDisplay                EQU        $0004
  355. kOSASelectScriptError            EQU        $0005
  356. kOSASelectDispose                EQU        $0006
  357. kOSASelectSetScriptInfo            EQU        $0007
  358. kOSASelectGetScriptInfo            EQU        $0008
  359. kOSASelectSetActiveProc            EQU        $0009
  360. kOSASelectGetActiveProc            EQU        $000A
  361. ;  Compiling: 
  362.  
  363. kOSASelectScriptingComponentName EQU    $0102
  364. kOSASelectCompile                EQU        $0103
  365. kOSASelectCopyID                EQU        $0104
  366. ;  GetSource: 
  367.  
  368. kOSASelectGetSource                EQU        $0201
  369. ;  AECoercion: 
  370.  
  371. kOSASelectCoerceFromDesc        EQU        $0301
  372. kOSASelectCoerceToDesc            EQU        $0302
  373. ;  AESending: 
  374.  
  375. kOSASelectSetSendProc            EQU        $0401
  376. kOSASelectGetSendProc            EQU        $0402
  377. kOSASelectSetCreateProc            EQU        $0403
  378. kOSASelectGetCreateProc            EQU        $0404
  379. kOSASelectSetDefaultTarget        EQU        $0405
  380. ;  Recording: 
  381.  
  382. kOSASelectStartRecording        EQU        $0501
  383. kOSASelectStopRecording            EQU        $0502
  384. ;  Convenience: 
  385.  
  386. kOSASelectLoadExecute            EQU        $0601
  387. kOSASelectCompileExecute        EQU        $0602
  388. kOSASelectDoScript                EQU        $0603
  389. ;  Dialects: 
  390.  
  391. kOSASelectSetCurrentDialect        EQU        $0701
  392. kOSASelectGetCurrentDialect        EQU        $0702
  393. kOSASelectAvailableDialects        EQU        $0703
  394. kOSASelectGetDialectInfo        EQU        $0704
  395. kOSASelectAvailableDialectCodeList EQU    $0705
  396. ;  Event Handling: 
  397.  
  398. kOSASelectSetResumeDispatchProc    EQU        $0801
  399. kOSASelectGetResumeDispatchProc    EQU        $0802
  400. kOSASelectExecuteEvent            EQU        $0803
  401. kOSASelectDoEvent                EQU        $0804
  402. kOSASelectMakeContext            EQU        $0805
  403.  
  404. ;  scripting component specific selectors are added beginning with this value  
  405.  
  406. kOSASelectComponentSpecificStart EQU    $1001
  407.  
  408. ;         Mode Flags:
  409. ;
  410. ;    Warning: These should not conflict with the AESend mode flags in
  411. ;    AppleEvents.h, because we may want to use them as OSA mode flags too.
  412. ;
  413.  
  414.  
  415. ; 
  416. ;        This mode flag may be passed to OSALoad, OSAStore or OSACompile to
  417. ;          instruct the scripting component to not retain the "source" of an
  418. ;          expression.  This will cause the OSAGetSource call to return the error
  419. ;          errOSASourceNotAvailable if used.  However, some scripting components
  420. ;          may not retain the source anyway.  This is mainly used when either space
  421. ;          efficiency is desired, or a script is to be "locked" so that its
  422. ;          implementation may not be viewed.
  423. ;    
  424.  
  425.  
  426. kOSAModePreventGetSource        EQU        $00000001
  427. ; 
  428. ;        These mode flags may be passed to OSACompile, OSAExecute, OSALoadExecute
  429. ;          OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  430. ;          indicate whether or not the script may interact with the user, switch
  431. ;          layer or reconnect if necessary.  Any AppleEvents will be sent with the
  432. ;          corresponding AESend mode supplied.
  433. ;    
  434.  
  435.  
  436. kOSAModeNeverInteract            EQU        $00000010
  437. kOSAModeCanInteract                EQU        $00000020
  438. kOSAModeAlwaysInteract            EQU        $00000030
  439. kOSAModeDontReconnect            EQU        $00000080
  440. ; 
  441. ;        This mode flag may be passed to OSACompile, OSAExecute, OSALoadExecute
  442. ;          OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  443. ;          indicate whether or not AppleEvents should be sent with the
  444. ;          kAECanSwitchLayer mode flag sent or not. NOTE: This flag is exactly the
  445. ;          opposite sense of the AppleEvent flag kAECanSwitchLayer.  This is to
  446. ;          provide a more convenient default, i.e. not supplying any mode
  447. ;          (kOSAModeNull) means to send events with kAECanSwitchLayer.  Supplying
  448. ;          the kOSAModeCantSwitchLayer mode flag will cause AESend to be called
  449. ;          without kAECanSwitchLayer.
  450. ;    
  451.  
  452.  
  453. kOSAModeCantSwitchLayer            EQU        $00000040
  454. ; 
  455. ;        This mode flag may be passed to OSACompile, OSAExecute, OSALoadExecute
  456. ;          OSACompileExecute, OSADoScript, OSAExecuteEvent, or OSADoEvent to
  457. ;          indicate whether or not AppleEvents should be sent with the kAEDontRecord
  458. ;          mode flag sent or not. NOTE: This flag is exactly the opposite sense of
  459. ;          the AppleEvent flag kAEDontRecord.  This is to provide a more convenient
  460. ;          default, i.e. not supplying any mode (kOSAModeNull) means to send events
  461. ;          with kAEDontRecord.  Supplying the kOSAModeDoRecord mode flag will 
  462. ;          cause AESend to be called without kAEDontRecord.
  463. ;    
  464.  
  465.  
  466. kOSAModeDoRecord                EQU        $00001000
  467. ; 
  468. ;        This is a mode flag for OSACompile that indicates that a context should
  469. ;          be created as the result of compilation. All handler definitions are
  470. ;          inserted into the new context, and variables are initialized by
  471. ;          evaluating their initial values in a null context (i.e. they must be
  472. ;          constant expressions).
  473. ;    
  474.  
  475.  
  476. kOSAModeCompileIntoContext        EQU        $00000002
  477. ; 
  478. ;        This is a mode flag for OSACompile that indicates that the previous
  479. ;          script ID (input to OSACompile) should be augmented with any new
  480. ;          definitions in the sourceData rather than replaced with a new script.
  481. ;          This means that the previous script ID must designate a context.
  482. ;          The presence of this flag causes the kOSAModeCompileIntoContext flag
  483. ;          to be implicitly used, causing any new definitions to be initialized
  484. ;          in a null context.
  485. ;    
  486.  
  487.  
  488. kOSAModeAugmentContext            EQU        $00000004
  489. ; 
  490. ;        This mode flag may be passed to OSADisplay or OSADoScript to indicate
  491. ;          that output only need be human-readable, not re-compilable by OSACompile.
  492. ;          If used, output may be arbitrarily "beautified", e.g. quotes may be left
  493. ;          off of string values, long lists may have elipses, etc.
  494. ;    
  495.  
  496.  
  497. kOSAModeDisplayForHumans        EQU        $00000008
  498. ; 
  499. ;        This mode flag may be passed to OSAStore in the case where the scriptID
  500. ;          is a context.  This causes the context to be saved, but not the context's
  501. ;          parent context.  When the stored context is loaded back in, the parent
  502. ;          will be kOSANullScript.
  503. ;    
  504.  
  505.  
  506. kOSAModeDontStoreParent            EQU        $00010000
  507. ; 
  508. ;        This mode flag may be passed to OSAExecuteEvent to cause the event to
  509. ;          be dispatched to the direct object of the event. The direct object (or
  510. ;          subject attribute if the direct object is a non-object specifier) will
  511. ;          be resolved, and the resulting script object will be the recipient of
  512. ;          the message. The context argument to OSAExecuteEvent will serve as the
  513. ;          root of the lookup/resolution process.
  514. ;    
  515.  
  516.  
  517. kOSAModeDispatchToDirectObject    EQU        $00020000
  518. ; 
  519. ;        This mode flag may be passed to OSAExecuteEvent to indicate that
  520. ;          components do not have to get the data of object specifier arguments.
  521. ;    
  522.  
  523.  
  524. kOSAModeDontGetDataForArguments    EQU        $00040000
  525. ; **************************************************************************
  526. ;    OSA Basic Scripting Interface
  527. ;**************************************************************************
  528. ;    Scripting components must at least support the Basic Scripting interface.
  529. ;*************************************************************************
  530.  
  531. ;         Loading and Storing Scripts:
  532. ;
  533. ;    These routines allow scripts to be loaded and stored in their internal
  534. ;    (possibly compiled, non-text) representation.
  535. ;
  536.  
  537.  
  538. ;  Resource type for scripts 
  539.  
  540. kOSAScriptResourceType            EQU        'scpt'
  541. ; 
  542. ;        Default type given to OSAStore which creates "generic" loadable script
  543. ;          data descriptors.
  544. ;    
  545.  
  546.  
  547. typeOSAGenericStorage            EQU        'scpt'
  548. ;
  549. ; pascal OSAError OSALoad(ComponentInstance scriptingComponent, const AEDesc *scriptData, long modeFlags, OSAID *resultingScriptID)
  550. ;
  551.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  552.         Macro
  553.         _OSALoad
  554.             move.l              #$000C0001,-(sp)
  555.             moveq               #0,D0
  556.             dc.w                $A82A
  557.         EndM
  558.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  559.         IMPORT_CFM_FUNCTION OSALoad
  560.     ENDIF
  561.  
  562. ; 
  563. ;        OSAComponentFunctionInline(kOSASelectLoad, 12);
  564. ;    
  565. ;        Errors:
  566. ;            badComponentInstance        invalid scripting component instance
  567. ;            errOSASystemError
  568. ;            errOSABadStorageType:        scriptData not for this scripting component
  569. ;            errOSACorruptData:            data seems to be corrupt
  570. ;            errOSADataFormatObsolete    script data format is no longer supported
  571. ;            errOSADataFormatTooNew        script data format is from a newer version
  572. ;        
  573. ;        ModeFlags:
  574. ;            kOSAModePreventGetSource
  575. ;    
  576.  
  577. ;
  578. ; pascal OSAError OSAStore(ComponentInstance scriptingComponent, OSAID scriptID, DescType desiredType, long modeFlags, AEDesc *resultingScriptData)
  579. ;
  580.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  581.         Macro
  582.         _OSAStore
  583.             move.l              #$00100002,-(sp)
  584.             moveq               #0,D0
  585.             dc.w                $A82A
  586.         EndM
  587.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  588.         IMPORT_CFM_FUNCTION OSAStore
  589.     ENDIF
  590.  
  591. ; 
  592. ;        OSAComponentFunctionInline(kOSASelectStore, 16);
  593. ;    
  594. ;        Errors:
  595. ;            badComponentInstance    invalid scripting component instance
  596. ;            errOSASystemError
  597. ;            errOSAInvalidID
  598. ;            errOSABadStorageType:    desiredType not for this scripting component
  599. ;        
  600. ;        ModeFlags:
  601. ;            kOSAModePreventGetSource
  602. ;            kOSAModeDontStoreParent
  603. ;    
  604.  
  605. ;  Executing Scripts: 
  606. ;
  607. ; pascal OSAError OSAExecute(ComponentInstance scriptingComponent, OSAID compiledScriptID, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  608. ;
  609.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  610.         Macro
  611.         _OSAExecute
  612.             move.l              #$00100003,-(sp)
  613.             moveq               #0,D0
  614.             dc.w                $A82A
  615.         EndM
  616.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  617.         IMPORT_CFM_FUNCTION OSAExecute
  618.     ENDIF
  619.  
  620. ; 
  621. ;        OSAComponentFunctionInline(kOSASelectExecute, 16);
  622. ;        This call runs a script.  The contextID represents the environment
  623. ;        with which global variables in the script are resolved.  The constant
  624. ;        kOSANullScript may be used for the contextID if the application wishes
  625. ;        to not deal with context directly (a default one is associated with each
  626. ;        scripting component instance).  The resultingScriptValueID is the 
  627. ;        result of evaluation, and contains a value which may be displayed using
  628. ;        the OSAGetSource call.  The modeFlags convey scripting component
  629. ;        specific information.
  630. ;    
  631. ;        Errors:
  632. ;            badComponentInstance    invalid scripting component instance
  633. ;            errOSASystemError
  634. ;            errOSAInvalidID
  635. ;            errOSAScriptError:        the executing script got an error
  636. ;    
  637. ;        ModeFlags:
  638. ;            kOSAModeNeverInteract
  639. ;            kOSAModeCanInteract
  640. ;            kOSAModeAlwaysInteract
  641. ;            kOSAModeCantSwitchLayer
  642. ;            kOSAModeDontReconnect
  643. ;            kOSAModeDoRecord
  644. ;    
  645.  
  646. ;  Displaying results: 
  647. ;
  648. ; pascal OSAError OSADisplay(ComponentInstance scriptingComponent, OSAID scriptValueID, DescType desiredType, long modeFlags, AEDesc *resultingText)
  649. ;
  650.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  651.         Macro
  652.         _OSADisplay
  653.             move.l              #$00100004,-(sp)
  654.             moveq               #0,D0
  655.             dc.w                $A82A
  656.         EndM
  657.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  658.         IMPORT_CFM_FUNCTION OSADisplay
  659.     ENDIF
  660.  
  661. ; 
  662. ;        OSAComponentFunctionInline(kOSASelectDisplay, 16);
  663. ;        This call is used to convert results (script value IDs) into displayable
  664. ;        text. The desiredType should be at least typeChar, and modeFlags are
  665. ;        scripting system specific flags to control the formatting of the
  666. ;        resulting text. This call differs from OSAGetSource in that (1) it
  667. ;        always produces at least typeChar, (2) is only works on script values,
  668. ;        (3) it may display it's output in non-compilable form (e.g. without
  669. ;        string quotes, elipses inserted in long and/or circular lists, etc.) and
  670. ;        (4) it is required by the basic scripting interface.
  671. ;    
  672. ;        Errors:
  673. ;            badComponentInstance    invalid scripting component instance
  674. ;            errOSASystemError
  675. ;            errOSAInvalidID
  676. ;            errAECoercionFail:        desiredType not supported by scripting component
  677. ;    
  678. ;        ModeFlags:
  679. ;            kOSAModeDisplayForHumans
  680. ;    
  681.  
  682. ;  Getting Error Information: 
  683. ;
  684. ; pascal OSAError OSAScriptError(ComponentInstance scriptingComponent, OSType selector, DescType desiredType, AEDesc *resultingErrorDescription)
  685. ;
  686.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  687.         Macro
  688.         _OSAScriptError
  689.             move.l              #$000C0005,-(sp)
  690.             moveq               #0,D0
  691.             dc.w                $A82A
  692.         EndM
  693.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  694.         IMPORT_CFM_FUNCTION OSAScriptError
  695.     ENDIF
  696.  
  697. ; 
  698. ;        OSAComponentFunctionInline(kOSASelectScriptError, 12);
  699. ;        Whenever script execution returns errOSAExecutionError, this routine
  700. ;        may be used to get information about that error.  The selector describes
  701. ;        the type of information desired about the error (various selectors are
  702. ;        listed below).  The desiredType indicates the data type of the result
  703. ;        desired for that selector.
  704. ;    
  705. ;        Errors:
  706. ;            badComponentInstance    invalid scripting component instance
  707. ;            errOSASystemError
  708. ;            errOSABadSelector:        selector not supported by scripting component
  709. ;            errAECoercionFail:        desiredType not supported by scripting component
  710. ;    
  711.  
  712. ;  OSAScriptError selectors: 
  713. ; 
  714. ;        This selector is used to determine the error number of a script error.
  715. ;        These error numbers may be either system error numbers, or error numbers
  716. ;        that are scripting component specific.
  717. ;        Required desiredTypes:    
  718. ;              typeShortInteger
  719. ;    
  720.  
  721.  
  722. kOSAErrorNumber                    EQU        'errn'
  723. ; 
  724. ;        This selector is used to determine the full error message associated
  725. ;        with the error number.  It should include the name of the application
  726. ;        which caused the error, as well as the specific error that occurred.
  727. ;        This selector is sufficient for simple error reporting (but see
  728. ;        kOSAErrorBriefMessage, below).
  729. ;        Required desiredTypes:
  730. ;            typeChar                    error message string
  731. ;    
  732.  
  733.  
  734. kOSAErrorMessage                EQU        'errs'
  735. ; 
  736. ;        This selector is used to determine a brief error message associated with
  737. ;        the error number.  This message and should not mention the name of the
  738. ;        application which caused the error, any partial results or offending
  739. ;        object (see kOSAErrorApp, kOSAErrorPartialResult and
  740. ;        kOSAErrorOffendingObject, below).
  741. ;        Required desiredTypes:
  742. ;              typeChar                    brief error message string
  743. ;    
  744.  
  745. ;   0x65727262  
  746.  
  747. kOSAErrorBriefMessage            EQU        'errb'
  748. ; 
  749. ;        This selector is used to determine which application actually got the
  750. ;        error (if it was the result of an AESend), or the current application
  751. ;        if ....
  752. ;        Required desiredTypes:
  753. ;              typeProcessSerialNumber        PSN of the errant application
  754. ;              typeChar                    name of the errant application
  755. ;    
  756.  
  757. ;   0x65726170  
  758.  
  759. kOSAErrorApp                    EQU        'erap'
  760. ; 
  761. ;        This selector is used to determine any partial result returned by an 
  762. ;        operation. If an AESend call failed, but a partial result was returned,
  763. ;        then the partial result may be returned as an AEDesc.
  764. ;        Required desiredTypes:
  765. ;              typeBest                    AEDesc of any partial result
  766. ;    
  767.  
  768. ;   0x70746c72   
  769.  
  770. kOSAErrorPartialResult            EQU        'ptlr'
  771. ; 
  772. ;        This selector is used to determine any object which caused the error
  773. ;        that may have been indicated by an application.  The result is an 
  774. ;        AEDesc.
  775. ;        Required desiredTypes:
  776. ;              typeBest                    AEDesc of any offending object
  777. ;    
  778.  
  779. ;   0x65726f62   
  780.  
  781. kOSAErrorOffendingObject        EQU        'erob'
  782. ; 
  783. ;        This selector is used to determine the type expected by a coercion 
  784. ;        operation if a type error occurred.
  785. ;    
  786.  
  787. ;   0x65727274   
  788.  
  789. kOSAErrorExpectedType            EQU        'errt'
  790. ; 
  791. ;        This selector is used to determine the source text range (start and 
  792. ;        end positions) of where the error occurred.
  793. ;        Required desiredTypes:
  794. ;              typeOSAErrorRange
  795. ;    
  796.  
  797. ;   0x65726e67  
  798.  
  799. kOSAErrorRange                    EQU        'erng'
  800. ; 
  801. ;        An AERecord type containing keyOSASourceStart and keyOSASourceEnd fields
  802. ;        of type short.
  803. ;    
  804.  
  805. ;   0x65726e67   
  806.  
  807. typeOSAErrorRange                EQU        'erng'
  808. ;  Field of a typeOSAErrorRange record of typeShortInteger 
  809. ;   0x73726373    
  810.  
  811. keyOSASourceStart                EQU        'srcs'
  812. ;  Field of a typeOSAErrorRange record of typeShortInteger 
  813. ;   0x73726365   
  814.  
  815. keyOSASourceEnd                    EQU        'srce'
  816. ;  Disposing Script IDs: 
  817. ;
  818. ; pascal OSAError OSADispose(ComponentInstance scriptingComponent, OSAID scriptID)
  819. ;
  820.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  821.         Macro
  822.         _OSADispose
  823.             move.l              #$00040006,-(sp)
  824.             moveq               #0,D0
  825.             dc.w                $A82A
  826.         EndM
  827.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  828.         IMPORT_CFM_FUNCTION OSADispose
  829.     ENDIF
  830.  
  831. ; 
  832. ;        OSAComponentFunctionInline(kOSASelectDispose, 4);
  833. ;        Disposes a script or context.
  834. ;    
  835. ;        Errors:
  836. ;            badComponentInstance    invalid scripting component instance
  837. ;            errOSASystemError
  838. ;            errOSAInvalidID
  839. ;    
  840.  
  841. ;  Getting and Setting Script Information: 
  842. ;
  843. ; pascal OSAError OSASetScriptInfo(ComponentInstance scriptingComponent, OSAID scriptID, OSType selector, long value)
  844. ;
  845.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  846.         Macro
  847.         _OSASetScriptInfo
  848.             move.l              #$000C0007,-(sp)
  849.             moveq               #0,D0
  850.             dc.w                $A82A
  851.         EndM
  852.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  853.         IMPORT_CFM_FUNCTION OSASetScriptInfo
  854.     ENDIF
  855.  
  856. ; 
  857. ;        OSAComponentFunctionInline(kOSASelectSetScriptInfo, 12);
  858. ;    
  859. ;        Errors:
  860. ;            badComponentInstance    invalid scripting component instance
  861. ;            errOSASystemError
  862. ;            errOSAInvalidID
  863. ;            errOSABadSelector:        selector not supported by scripting component
  864. ;                                    or selector not for this scriptID
  865. ;    
  866.  
  867. ;
  868. ; pascal OSAError OSAGetScriptInfo(ComponentInstance scriptingComponent, OSAID scriptID, OSType selector, long *result)
  869. ;
  870.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  871.         Macro
  872.         _OSAGetScriptInfo
  873.             move.l              #$000C0008,-(sp)
  874.             moveq               #0,D0
  875.             dc.w                $A82A
  876.         EndM
  877.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  878.         IMPORT_CFM_FUNCTION OSAGetScriptInfo
  879.     ENDIF
  880.  
  881. ; 
  882. ;        OSAComponentFunctionInline(kOSASelectGetScriptInfo, 12);
  883. ;    
  884. ;        Errors:
  885. ;            badComponentInstance    invalid scripting component instance
  886. ;            errOSASystemError
  887. ;            errOSAInvalidID
  888. ;            errOSABadSelector:        selector not supported by scripting component
  889. ;                                    or selector not for this scriptID
  890. ;    
  891.  
  892. ;  Manipulating the ActiveProc:
  893. ;
  894. ;    Scripting systems will supply default values for these procedures if they
  895. ;    are not set by the client:
  896. ;
  897.  
  898. ;
  899. ; pascal OSAError OSASetActiveProc(ComponentInstance scriptingComponent, OSAActiveUPP activeProc, long refCon)
  900. ;
  901.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  902.         Macro
  903.         _OSASetActiveProc
  904.             move.l              #$00080009,-(sp)
  905.             moveq               #0,D0
  906.             dc.w                $A82A
  907.         EndM
  908.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  909.         IMPORT_CFM_FUNCTION OSASetActiveProc
  910.     ENDIF
  911.  
  912. ; 
  913. ;        OSAComponentFunctionInline(kOSASelectSetActiveProc, 8);
  914. ;        If activeProc is nil, the default activeProc is used.
  915. ;    
  916. ;        Errors:
  917. ;            badComponentInstance    invalid scripting component instance
  918. ;            errOSASystemError
  919. ;    
  920.  
  921. ;
  922. ; pascal OSAError OSAGetActiveProc(ComponentInstance scriptingComponent, OSAActiveUPP *activeProc, long *refCon)
  923. ;
  924.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  925.         Macro
  926.         _OSAGetActiveProc
  927.             move.l              #$0008000A,-(sp)
  928.             moveq               #0,D0
  929.             dc.w                $A82A
  930.         EndM
  931.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  932.         IMPORT_CFM_FUNCTION OSAGetActiveProc
  933.     ENDIF
  934.  
  935. ; 
  936. ;        OSAComponentFunctionInline(kOSASelectGetActiveProc, 8);
  937. ;    
  938. ;        Errors:
  939. ;            badComponentInstance    invalid scripting component instance
  940. ;            errOSASystemError
  941. ;    
  942.  
  943. ; **************************************************************************
  944. ;    OSA Optional Compiling Interface
  945. ;**************************************************************************
  946. ;    Scripting components that support the Compiling interface have the 
  947. ;    kOSASupportsCompiling bit set in it's ComponentDescription.
  948. ;*************************************************************************
  949.  
  950. ;
  951. ; pascal OSAError OSAScriptingComponentName(ComponentInstance scriptingComponent, AEDesc *resultingScriptingComponentName)
  952. ;
  953.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  954.         Macro
  955.         _OSAScriptingComponentName
  956.             move.l              #$00040102,-(sp)
  957.             moveq               #0,D0
  958.             dc.w                $A82A
  959.         EndM
  960.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  961.         IMPORT_CFM_FUNCTION OSAScriptingComponentName
  962.     ENDIF
  963.  
  964. ; 
  965. ;        OSAComponentFunctionInline(kOSASelectScriptingComponentName, 4);
  966. ;        Given a scripting component, this routine returns the name of that
  967. ;        scripting component in a type that is coercable to text (typeChar).
  968. ;        The generic scripting component returns the name of the default
  969. ;        scripting component.  This name should be sufficient to convey to the
  970. ;        user the kind of script (syntax) he is expected to write.
  971. ;    
  972. ;        Errors:
  973. ;            badComponentInstance    invalid scripting component instance
  974. ;            errOSASystemError
  975. ;    
  976.  
  977. ;
  978. ; pascal OSAError OSACompile(ComponentInstance scriptingComponent, const AEDesc *sourceData, long modeFlags, OSAID *previousAndResultingScriptID)
  979. ;
  980.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  981.         Macro
  982.         _OSACompile
  983.             move.l              #$000C0103,-(sp)
  984.             moveq               #0,D0
  985.             dc.w                $A82A
  986.         EndM
  987.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  988.         IMPORT_CFM_FUNCTION OSACompile
  989.     ENDIF
  990.  
  991. ; 
  992. ;        OSAComponentFunctionInline(kOSASelectCompile, 12);
  993. ;        Coerces input desc (possibly text) into a script's internal format.
  994. ;        Once compiled, the script is ready to run.  The modeFlags convey
  995. ;        scripting component specific information.  The previous script ID
  996. ;        (result parameter) is made to refer to the newly compiled script,
  997. ;        unless it was originally kOSANullScript.  In this case a new script
  998. ;        ID is created and used.
  999. ;    
  1000. ;        Errors:
  1001. ;            badComponentInstance    invalid scripting component instance
  1002. ;            errOSASystemError
  1003. ;            errAECoercionFail:        sourceData is not compilable
  1004. ;            errOSAScriptError:        sourceData was a bad script (syntax error)
  1005. ;            errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1006. ;                                    valid on input
  1007. ;    
  1008. ;        ModeFlags:
  1009. ;            kOSAModePreventGetSource
  1010. ;            kOSAModeCompileIntoContext
  1011. ;            kOSAModeAugmentContext
  1012. ;            kOSAModeNeverInteract
  1013. ;            kOSAModeCanInteract
  1014. ;            kOSAModeAlwaysInteract
  1015. ;            kOSAModeCantSwitchLayer
  1016. ;            kOSAModeDontReconnect
  1017. ;            kOSAModeDoRecord
  1018. ;    
  1019.  
  1020. ;
  1021. ; pascal OSAError OSACopyID(ComponentInstance scriptingComponent, OSAID fromID, OSAID *toID)
  1022. ;
  1023.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1024.         Macro
  1025.         _OSACopyID
  1026.             move.l              #$00080104,-(sp)
  1027.             moveq               #0,D0
  1028.             dc.w                $A82A
  1029.         EndM
  1030.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1031.         IMPORT_CFM_FUNCTION OSACopyID
  1032.     ENDIF
  1033.  
  1034. ; 
  1035. ;        OSAComponentFunctionInline(kOSASelectCopyID, 8);
  1036. ;        If toID is a reference to kOSANullScript then it is updated to have a
  1037. ;        new scriptID value.  This call can be used to perform undo or revert
  1038. ;        operations on scripts. 
  1039. ;    
  1040. ;        Errors:
  1041. ;            badComponentInstance    invalid scripting component instance
  1042. ;            errOSASystemError
  1043. ;            errOSAInvalidID
  1044. ;    
  1045.  
  1046. ; **************************************************************************
  1047. ;    OSA Optional GetSource Interface
  1048. ;**************************************************************************
  1049. ;    Scripting components that support the GetSource interface have the 
  1050. ;    kOSASupportsGetSource bit set in it's ComponentDescription.
  1051. ;*************************************************************************
  1052.  
  1053. ;
  1054. ; pascal OSAError OSAGetSource(ComponentInstance scriptingComponent, OSAID scriptID, DescType desiredType, AEDesc *resultingSourceData)
  1055. ;
  1056.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1057.         Macro
  1058.         _OSAGetSource
  1059.             move.l              #$000C0201,-(sp)
  1060.             moveq               #0,D0
  1061.             dc.w                $A82A
  1062.         EndM
  1063.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1064.         IMPORT_CFM_FUNCTION OSAGetSource
  1065.     ENDIF
  1066.  
  1067. ; 
  1068. ;        OSAComponentFunctionInline(kOSASelectGetSource, 12);
  1069. ;        This routine causes a compiled script to be output in a form (possibly
  1070. ;        text) such that it is suitable to be passed back to OSACompile.
  1071. ;
  1072. ;        Errors:
  1073. ;            badComponentInstance    invalid scripting component instance
  1074. ;            errOSASystemError
  1075. ;            errOSAInvalidID
  1076. ;            errOSASourceNotAvailable    can't get source for this scriptID
  1077. ;    
  1078.  
  1079. ; **************************************************************************
  1080. ;    OSA Optional AECoercion Interface
  1081. ;**************************************************************************
  1082. ;    Scripting components that support the AECoercion interface have the 
  1083. ;    kOSASupportsAECoercion bit set in it's ComponentDescription.
  1084. ;*************************************************************************
  1085.  
  1086. ;
  1087. ; pascal OSAError OSACoerceFromDesc(ComponentInstance scriptingComponent, const AEDesc *scriptData, long modeFlags, OSAID *resultingScriptID)
  1088. ;
  1089.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1090.         Macro
  1091.         _OSACoerceFromDesc
  1092.             move.l              #$000C0301,-(sp)
  1093.             moveq               #0,D0
  1094.             dc.w                $A82A
  1095.         EndM
  1096.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1097.         IMPORT_CFM_FUNCTION OSACoerceFromDesc
  1098.     ENDIF
  1099.  
  1100. ; 
  1101. ;        OSAComponentFunctionInline(kOSASelectCoerceFromDesc, 12);
  1102. ;        This routine causes script data to be coerced into a script value.
  1103. ;        If the scriptData is an AppleEvent, then the resultingScriptID is a
  1104. ;        compiled script ID (mode flags for OSACompile may be used in this case).
  1105. ;        Other scriptData descriptors create script value IDs.
  1106. ;    
  1107. ;        Errors:
  1108. ;            badComponentInstance    invalid scripting component instance
  1109. ;            errOSASystemError
  1110. ;    
  1111. ;        ModeFlags:
  1112. ;            kOSAModePreventGetSource
  1113. ;            kOSAModeCompileIntoContext
  1114. ;            kOSAModeNeverInteract
  1115. ;            kOSAModeCanInteract
  1116. ;            kOSAModeAlwaysInteract
  1117. ;            kOSAModeCantSwitchLayer
  1118. ;            kOSAModeDontReconnect
  1119. ;            kOSAModeDoRecord
  1120. ;    
  1121.  
  1122. ;
  1123. ; pascal OSAError OSACoerceToDesc(ComponentInstance scriptingComponent, OSAID scriptID, DescType desiredType, long modeFlags, AEDesc *result)
  1124. ;
  1125.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1126.         Macro
  1127.         _OSACoerceToDesc
  1128.             move.l              #$00100302,-(sp)
  1129.             moveq               #0,D0
  1130.             dc.w                $A82A
  1131.         EndM
  1132.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1133.         IMPORT_CFM_FUNCTION OSACoerceToDesc
  1134.     ENDIF
  1135.  
  1136. ; 
  1137. ;        OSAComponentFunctionInline(kOSASelectCoerceToDesc, 16);
  1138. ;        This routine causes a script value to be coerced into any desired form.
  1139. ;        If the scriptID denotes a compiled script, then it may be coerced to 
  1140. ;        typeAppleEvent.
  1141. ;    
  1142. ;        Errors:
  1143. ;            badComponentInstance    invalid scripting component instance
  1144. ;            errOSASystemError
  1145. ;            errOSAInvalidID
  1146. ;    
  1147.  
  1148. ; **************************************************************************
  1149. ;    OSA Optional AESending Interface
  1150. ;**************************************************************************
  1151. ;    Scripting components that support the AESending interface have the 
  1152. ;    kOSASupportsAESending bit set in it's ComponentDescription.
  1153. ;*************************************************************************
  1154.  
  1155. ; 
  1156. ;    Scripting systems will supply default values for these procedures if they
  1157. ;    are not set by the client:
  1158. ;
  1159.  
  1160. ;
  1161. ; pascal OSAError OSASetSendProc(ComponentInstance scriptingComponent, OSASendUPP sendProc, long refCon)
  1162. ;
  1163.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1164.         Macro
  1165.         _OSASetSendProc
  1166.             move.l              #$00080401,-(sp)
  1167.             moveq               #0,D0
  1168.             dc.w                $A82A
  1169.         EndM
  1170.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1171.         IMPORT_CFM_FUNCTION OSASetSendProc
  1172.     ENDIF
  1173.  
  1174. ; 
  1175. ;        OSAComponentFunctionInline(kOSASelectSetSendProc, 8);
  1176. ;        If sendProc is nil, the default sendProc is used.
  1177. ;    
  1178. ;        Errors:
  1179. ;            badComponentInstance    invalid scripting component instance
  1180. ;            errOSASystemError
  1181. ;    
  1182.  
  1183. ;
  1184. ; pascal OSAError OSAGetSendProc(ComponentInstance scriptingComponent, OSASendUPP *sendProc, long *refCon)
  1185. ;
  1186.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1187.         Macro
  1188.         _OSAGetSendProc
  1189.             move.l              #$00080402,-(sp)
  1190.             moveq               #0,D0
  1191.             dc.w                $A82A
  1192.         EndM
  1193.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1194.         IMPORT_CFM_FUNCTION OSAGetSendProc
  1195.     ENDIF
  1196.  
  1197. ; 
  1198. ;        OSAComponentFunctionInline(kOSASelectGetSendProc, 8);
  1199. ;    
  1200. ;        Errors:
  1201. ;            badComponentInstance    invalid scripting component instance
  1202. ;            errOSASystemError
  1203. ;    
  1204.  
  1205. ;
  1206. ; pascal OSAError OSASetCreateProc(ComponentInstance scriptingComponent, OSACreateAppleEventUPP createProc, long refCon)
  1207. ;
  1208.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1209.         Macro
  1210.         _OSASetCreateProc
  1211.             move.l              #$00080403,-(sp)
  1212.             moveq               #0,D0
  1213.             dc.w                $A82A
  1214.         EndM
  1215.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1216.         IMPORT_CFM_FUNCTION OSASetCreateProc
  1217.     ENDIF
  1218.  
  1219. ; 
  1220. ;        OSAComponentFunctionInline(kOSASelectSetCreateProc, 8);
  1221. ;        If createProc is nil, the default createProc is used.
  1222. ;    
  1223. ;        Errors:
  1224. ;            badComponentInstance    invalid scripting component instance
  1225. ;            errOSASystemError
  1226. ;    
  1227.  
  1228. ;
  1229. ; pascal OSAError OSAGetCreateProc(ComponentInstance scriptingComponent, OSACreateAppleEventUPP *createProc, long *refCon)
  1230. ;
  1231.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1232.         Macro
  1233.         _OSAGetCreateProc
  1234.             move.l              #$00080404,-(sp)
  1235.             moveq               #0,D0
  1236.             dc.w                $A82A
  1237.         EndM
  1238.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1239.         IMPORT_CFM_FUNCTION OSAGetCreateProc
  1240.     ENDIF
  1241.  
  1242. ; 
  1243. ;        OSAComponentFunctionInline(kOSASelectGetCreateProc, 8);
  1244. ;    
  1245. ;        Errors:
  1246. ;            badComponentInstance    invalid scripting component instance
  1247. ;            errOSASystemError
  1248. ;    
  1249.  
  1250. ;
  1251. ; pascal OSAError OSASetDefaultTarget(ComponentInstance scriptingComponent, const AEAddressDesc *target)
  1252. ;
  1253.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1254.         Macro
  1255.         _OSASetDefaultTarget
  1256.             move.l              #$00040405,-(sp)
  1257.             moveq               #0,D0
  1258.             dc.w                $A82A
  1259.         EndM
  1260.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1261.         IMPORT_CFM_FUNCTION OSASetDefaultTarget
  1262.     ENDIF
  1263.  
  1264. ; 
  1265. ;        OSAComponentFunctionInline(kOSASelectSetDefaultTarget, 4);
  1266. ;        This routine sets the default target application for AE sending.
  1267. ;        It also establishes the default target from which terminologies come.
  1268. ;        It is effectively like having an AppleScript "tell" statement around
  1269. ;        the entire program.  If this routine is not called, or if the target 
  1270. ;        is a null AEDesc, then the current application is the default target.
  1271. ;    
  1272. ;        Errors:
  1273. ;            badComponentInstance    invalid scripting component instance
  1274. ;            errOSASystemError
  1275. ;    
  1276.  
  1277. ; **************************************************************************
  1278. ;    OSA Optional Recording Interface
  1279. ;**************************************************************************
  1280. ;    Scripting components that support the Recording interface have the 
  1281. ;    kOSASupportsRecording bit set in it's ComponentDescription.
  1282. ;*************************************************************************
  1283.  
  1284. ;
  1285. ; pascal OSAError OSAStartRecording(ComponentInstance scriptingComponent, OSAID *compiledScriptToModifyID)
  1286. ;
  1287.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1288.         Macro
  1289.         _OSAStartRecording
  1290.             move.l              #$00040501,-(sp)
  1291.             moveq               #0,D0
  1292.             dc.w                $A82A
  1293.         EndM
  1294.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1295.         IMPORT_CFM_FUNCTION OSAStartRecording
  1296.     ENDIF
  1297.  
  1298. ; 
  1299. ;        OSAComponentFunctionInline(kOSASelectStartRecording, 4);
  1300. ;        Starts recording.  If compiledScriptToModifyID is kOSANullScript, a
  1301. ;        new script ID is created and returned.  If the current application has
  1302. ;        a handler for the kOSARecordedText event, then kOSARecordedText events
  1303. ;        are sent to the application containing the text of each AppleEvent 
  1304. ;        recorded.
  1305. ;    
  1306. ;        Errors:
  1307. ;            badComponentInstance    invalid scripting component instance
  1308. ;            errOSASystemError
  1309. ;            errOSAInvalidID
  1310. ;            errOSARecordingIsAlreadyOn
  1311. ;    
  1312.  
  1313. ;
  1314. ; pascal OSAError OSAStopRecording(ComponentInstance scriptingComponent, OSAID compiledScriptID)
  1315. ;
  1316.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1317.         Macro
  1318.         _OSAStopRecording
  1319.             move.l              #$00040502,-(sp)
  1320.             moveq               #0,D0
  1321.             dc.w                $A82A
  1322.         EndM
  1323.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1324.         IMPORT_CFM_FUNCTION OSAStopRecording
  1325.     ENDIF
  1326.  
  1327. ; 
  1328. ;        OSAComponentFunctionInline(kOSASelectStopRecording, 4);
  1329. ;        If compiledScriptID is not being recorded into or recording is not
  1330. ;        currently on, no error is returned.
  1331. ;    
  1332. ;        Errors:
  1333. ;            badComponentInstance    invalid scripting component instance
  1334. ;            errOSASystemError
  1335. ;            errOSAInvalidID
  1336. ;    
  1337.  
  1338. ; **************************************************************************
  1339. ;    OSA Optional Convenience Interface
  1340. ;**************************************************************************
  1341. ;    Scripting components that support the Convenience interface have the 
  1342. ;    kOSASupportsConvenience bit set in it's ComponentDescription.
  1343. ;*************************************************************************
  1344.  
  1345. ;
  1346. ; pascal OSAError OSALoadExecute(ComponentInstance scriptingComponent, const AEDesc *scriptData, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  1347. ;
  1348.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1349.         Macro
  1350.         _OSALoadExecute
  1351.             move.l              #$00100601,-(sp)
  1352.             moveq               #0,D0
  1353.             dc.w                $A82A
  1354.         EndM
  1355.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1356.         IMPORT_CFM_FUNCTION OSALoadExecute
  1357.     ENDIF
  1358.  
  1359. ; 
  1360. ;        OSAComponentFunctionInline(kOSASelectLoadExecute, 16);
  1361. ;        This routine is effectively equivalent to calling OSALoad followed by
  1362. ;        OSAExecute.  After execution, the compiled source is disposed.  Only the
  1363. ;        resulting value ID is retained.
  1364. ;    
  1365. ;        Errors:
  1366. ;            badComponentInstance        invalid scripting component instance
  1367. ;            errOSASystemError
  1368. ;            errOSABadStorageType:        scriptData not for this scripting component
  1369. ;            errOSACorruptData:            data seems to be corrupt
  1370. ;            errOSADataFormatObsolete    script data format is no longer supported
  1371. ;            errOSADataFormatTooNew        script data format is from a newer version
  1372. ;            errOSAInvalidID
  1373. ;            errOSAScriptError:            the executing script got an error
  1374. ;    
  1375. ;        ModeFlags:
  1376. ;            kOSAModeNeverInteract
  1377. ;            kOSAModeCanInteract
  1378. ;            kOSAModeAlwaysInteract
  1379. ;            kOSAModeCantSwitchLayer
  1380. ;            kOSAModeDontReconnect
  1381. ;            kOSAModeDoRecord
  1382. ;    
  1383.  
  1384. ;
  1385. ; pascal OSAError OSACompileExecute(ComponentInstance scriptingComponent, const AEDesc *sourceData, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  1386. ;
  1387.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1388.         Macro
  1389.         _OSACompileExecute
  1390.             move.l              #$00100602,-(sp)
  1391.             moveq               #0,D0
  1392.             dc.w                $A82A
  1393.         EndM
  1394.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1395.         IMPORT_CFM_FUNCTION OSACompileExecute
  1396.     ENDIF
  1397.  
  1398. ; 
  1399. ;        OSAComponentFunctionInline(kOSASelectCompileExecute, 16);
  1400. ;        This routine is effectively equivalent to calling OSACompile followed by
  1401. ;        OSAExecute.  After execution, the compiled source is disposed.  Only the
  1402. ;        resulting value ID is retained.
  1403. ;    
  1404. ;        Errors:
  1405. ;            badComponentInstance    invalid scripting component instance
  1406. ;            errOSASystemError
  1407. ;            errAECoercionFail:        sourceData is not compilable
  1408. ;            errOSAScriptError:        sourceData was a bad script (syntax error)
  1409. ;            errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1410. ;                                    valid on input
  1411. ;            errOSAScriptError:        the executing script got an error
  1412. ;    
  1413. ;        ModeFlags:
  1414. ;            kOSAModeNeverInteract
  1415. ;            kOSAModeCanInteract
  1416. ;            kOSAModeAlwaysInteract
  1417. ;            kOSAModeCantSwitchLayer
  1418. ;            kOSAModeDontReconnect
  1419. ;            kOSAModeDoRecord
  1420. ;    
  1421.  
  1422. ;
  1423. ; pascal OSAError OSADoScript(ComponentInstance scriptingComponent, const AEDesc *sourceData, OSAID contextID, DescType desiredType, long modeFlags, AEDesc *resultingText)
  1424. ;
  1425.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1426.         Macro
  1427.         _OSADoScript
  1428.             move.l              #$00140603,-(sp)
  1429.             moveq               #0,D0
  1430.             dc.w                $A82A
  1431.         EndM
  1432.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1433.         IMPORT_CFM_FUNCTION OSADoScript
  1434.     ENDIF
  1435.  
  1436. ; 
  1437. ;        OSAComponentFunctionInline(kOSASelectDoScript, 20);
  1438. ;        This routine is effectively equivalent to calling OSACompile followed by
  1439. ;        OSAExecute and then OSADisplay.  After execution, the compiled source
  1440. ;        and the resulting value are is disposed.  Only the resultingText
  1441. ;        descriptor is retained.  If a script error occur during processing, the 
  1442. ;        resultingText gets the error message of the error, and errOSAScriptError
  1443. ;        is returned.  OSAScriptError may still be used to extract more 
  1444. ;        information about the particular error.
  1445. ;    
  1446. ;        Errors:
  1447. ;            badComponentInstance    invalid scripting component instance
  1448. ;            errOSASystemError
  1449. ;            errAECoercionFail:        sourceData is not compilable or 
  1450. ;                                    desiredType not supported by scripting component
  1451. ;            errOSAScriptError:        sourceData was a bad script (syntax error)
  1452. ;            errOSAInvalidID:        previousAndResultingCompiledScriptID was not
  1453. ;                                    valid on input
  1454. ;            errOSAScriptError:        the executing script got an error
  1455. ;    
  1456. ;        ModeFlags:
  1457. ;            kOSAModeNeverInteract
  1458. ;            kOSAModeCanInteract
  1459. ;            kOSAModeAlwaysInteract
  1460. ;            kOSAModeCantSwitchLayer
  1461. ;            kOSAModeDontReconnect
  1462. ;            kOSAModeDoRecord
  1463. ;            kOSAModeDisplayForHumans
  1464. ;    
  1465.  
  1466. ; **************************************************************************
  1467. ;    OSA Optional Dialects Interface
  1468. ;**************************************************************************
  1469. ;    Scripting components that support the Dialects interface have the 
  1470. ;    kOSASupportsDialects bit set in it's ComponentDescription.
  1471. ;*************************************************************************
  1472.  
  1473. ; 
  1474. ;    These calls allows an scripting component that supports different dialects
  1475. ;    to dynamically switch between those dialects.  Although this interface is
  1476. ;    specified, the particular dialect codes are scripting component dependent.
  1477. ;
  1478.  
  1479. ;
  1480. ; pascal OSAError OSASetCurrentDialect(ComponentInstance scriptingComponent, short dialectCode)
  1481. ;
  1482.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1483.         Macro
  1484.         _OSASetCurrentDialect
  1485.             move.l              #$00020701,-(sp)
  1486.             moveq               #0,D0
  1487.             dc.w                $A82A
  1488.         EndM
  1489.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1490.         IMPORT_CFM_FUNCTION OSASetCurrentDialect
  1491.     ENDIF
  1492.  
  1493. ; 
  1494. ;        OSAComponentFunctionInline(kOSASelectSetCurrentDialect, 2);
  1495. ;    
  1496. ;        Errors:
  1497. ;            badComponentInstance    invalid scripting component instance
  1498. ;            errOSASystemError
  1499. ;            errOSANoSuchDialect:    invalid dialectCode
  1500. ;    
  1501.  
  1502. ;
  1503. ; pascal OSAError OSAGetCurrentDialect(ComponentInstance scriptingComponent, short *resultingDialectCode)
  1504. ;
  1505.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1506.         Macro
  1507.         _OSAGetCurrentDialect
  1508.             move.l              #$00040702,-(sp)
  1509.             moveq               #0,D0
  1510.             dc.w                $A82A
  1511.         EndM
  1512.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1513.         IMPORT_CFM_FUNCTION OSAGetCurrentDialect
  1514.     ENDIF
  1515.  
  1516. ; 
  1517. ;        OSAComponentFunctionInline(kOSASelectGetCurrentDialect, 4);
  1518. ;    
  1519. ;        Errors:
  1520. ;            badComponentInstance    invalid scripting component instance
  1521. ;            errOSASystemError
  1522. ;    
  1523.  
  1524. ;
  1525. ; pascal OSAError OSAAvailableDialects(ComponentInstance scriptingComponent, AEDesc *resultingDialectInfoList)
  1526. ;
  1527.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1528.         Macro
  1529.         _OSAAvailableDialects
  1530.             move.l              #$00040703,-(sp)
  1531.             moveq               #0,D0
  1532.             dc.w                $A82A
  1533.         EndM
  1534.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1535.         IMPORT_CFM_FUNCTION OSAAvailableDialects
  1536.     ENDIF
  1537.  
  1538. ; 
  1539. ;        OSAComponentFunctionInline(kOSASelectAvailableDialects, 4);
  1540. ;        This call return an AEList containing information about each of the
  1541. ;        currently available dialects of a scripting component.  Each item
  1542. ;        is an AERecord of typeOSADialectInfo that contains at least the fields
  1543. ;        keyOSADialectName, keyOSADialectCode, KeyOSADialectLangCode and 
  1544. ;        keyOSADialectScriptCode.
  1545. ;    
  1546. ;        Errors:
  1547. ;            badComponentInstance    invalid scripting component instance
  1548. ;            errOSASystemError
  1549. ;    
  1550.  
  1551. ;
  1552. ; pascal OSAError OSAGetDialectInfo(ComponentInstance scriptingComponent, short dialectCode, OSType selector, AEDesc *resultingDialectInfo)
  1553. ;
  1554.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1555.         Macro
  1556.         _OSAGetDialectInfo
  1557.             move.l              #$000A0704,-(sp)
  1558.             moveq               #0,D0
  1559.             dc.w                $A82A
  1560.         EndM
  1561.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1562.         IMPORT_CFM_FUNCTION OSAGetDialectInfo
  1563.     ENDIF
  1564.  
  1565. ; 
  1566. ;        OSAComponentFunctionInline(kOSASelectGetDialectInfo, 10);
  1567. ;        This call gives information about the specified dialect of a scripting
  1568. ;        component. It returns an AEDesc whose type depends on the selector 
  1569. ;        specified. Available selectors are the same as the field keys for a
  1570. ;        dialect info record. The type of AEDesc returned is the same as the 
  1571. ;        type of the field that has same key as the selector.
  1572. ;    
  1573. ;        Errors:
  1574. ;            badComponentInstance    invalid scripting component instance
  1575. ;            errOSASystemError
  1576. ;             errOSABadSelector
  1577. ;            errOSANoSuchDialect:    invalid dialectCode
  1578. ;    
  1579.  
  1580. ;
  1581. ; pascal OSAError OSAAvailableDialectCodeList(ComponentInstance scriptingComponent, AEDesc *resultingDialectCodeList)
  1582. ;
  1583.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1584.         Macro
  1585.         _OSAAvailableDialectCodeList
  1586.             move.l              #$00040705,-(sp)
  1587.             moveq               #0,D0
  1588.             dc.w                $A82A
  1589.         EndM
  1590.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1591.         IMPORT_CFM_FUNCTION OSAAvailableDialectCodeList
  1592.     ENDIF
  1593.  
  1594. ; 
  1595. ;        OSAComponentFunctionInline(kOSASelectAvailableDialectCodeList, 4);
  1596. ;        This is alternative to OSAGetAvailableDialectCodeList. Use this call
  1597. ;        and  OSAGetDialectInfo to get information on dialects.
  1598. ;        This call return an AEList containing dialect code for each of the
  1599. ;        currently available dialects of a scripting component. Each dialect
  1600. ;        code is a short integer of type typeShortInteger.
  1601. ;    
  1602. ;        Errors:
  1603. ;            badComponentInstance    invalid scripting component instance
  1604. ;            errOSASystemError
  1605. ;
  1606. ;        Type of a dialect info record containing at least keyOSADialectName
  1607. ;        and keyOSADialectCode fields.
  1608. ;
  1609. ;        keys for dialect info record, also used as selectors to OSAGetDialectInfo.
  1610. ;
  1611. ;        Field of a typeOSADialectInfo record of typeChar.
  1612. ;        Field of a typeOSADialectInfo record of typeShortInteger.
  1613. ;        Field of a typeOSADialectInfo record of typeShortInteger.
  1614. ;        Field of a typeOSADialectInfo record of typeShortInteger.
  1615. ;    
  1616.  
  1617. ; **************************************************************************
  1618. ;    OSA Optional Event Handling Interface
  1619. ;**************************************************************************
  1620. ;    Scripting components that support the Event Handling interface have the 
  1621. ;    kOSASupportsEventHandling bit set in it's ComponentDescription.
  1622. ;*************************************************************************
  1623.  
  1624. ;
  1625. ; pascal OSAError OSASetResumeDispatchProc(ComponentInstance scriptingComponent, AEEventHandlerUPP resumeDispatchProc, long refCon)
  1626. ;
  1627.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1628.         Macro
  1629.         _OSASetResumeDispatchProc
  1630.             move.l              #$00080801,-(sp)
  1631.             moveq               #0,D0
  1632.             dc.w                $A82A
  1633.         EndM
  1634.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1635.         IMPORT_CFM_FUNCTION OSASetResumeDispatchProc
  1636.     ENDIF
  1637.  
  1638. ; 
  1639. ;        OSAComponentFunctionInline(kOSASelectSetResumeDispatchProc, 8);
  1640. ;        This function is used to set the ResumeDispatchProc that will be used
  1641. ;        by OSAExecuteEvent and OSADoEvent if either no event handler can be
  1642. ;        found in the context, or the context event hander "continues" control
  1643. ;        onward. The two constants kOSAUseStandardDispatch and kOSANoDispatch
  1644. ;        may also be passed to this routine indicating that the handler registered
  1645. ;        in the application with AEInstallEventHandler should be used, or no
  1646. ;        dispatch should occur, respectively.
  1647. ;    
  1648. ;        Errors:
  1649. ;            badComponentInstance    invalid scripting component instance
  1650. ;            errOSASystemError
  1651. ;    
  1652.  
  1653.  
  1654. kOSAUseStandardDispatch            EQU        $FFFFFFFF
  1655. ; 
  1656. ;        Special ResumeDispatchProc constant which may be passed to 
  1657. ;        OSASetResumeDispatchProc indicating that the handler registered
  1658. ;        in the application with AEInstallEventHandler should be used.
  1659. ;        
  1660. ;        NOTE:    Had to remove the cast (AEEventHandlerUPP).  The C compiler
  1661. ;                doesn't allow pointer types to be assigned to an enum.  All
  1662. ;                constants must be assigned as enums to translate properly to
  1663. ;                Pascal.
  1664. ;    
  1665.  
  1666.  
  1667. kOSANoDispatch                    EQU        0
  1668. ; 
  1669. ;        Special ResumeDispatchProc constant which may be passed to 
  1670. ;        OSASetResumeDispatchProc indicating that no dispatch should occur.
  1671. ;        
  1672. ;        NOTE:    Had to remove the cast (AEEventHandlerUPP).  The C compiler
  1673. ;                doesn't allow pointer types to be assigned to an enum.  All
  1674. ;                constants must be assigned as enums to translate properly to
  1675. ;                Pascal.
  1676. ;    
  1677.  
  1678.  
  1679. kOSADontUsePhac                    EQU        $0001
  1680. ; 
  1681. ;        Special refCon constant that may be given to OSASetResumeDispatchProc
  1682. ;        only when kOSAUseStandardDispatch is used as the ResumeDispatchProc.
  1683. ;        This causes the standard dispatch to be performed, except the phac
  1684. ;        handler is not called.  This is useful during tinkerability, when
  1685. ;        the phac handler is used to lookup a context associated with an event's 
  1686. ;        direct parameter, and call OSAExecuteEvent or OSADoEvent.  Failure to
  1687. ;        bypass the phac handler would result in an infinite loop.
  1688. ;    
  1689.  
  1690. ;
  1691. ; pascal OSAError OSAGetResumeDispatchProc(ComponentInstance scriptingComponent, AEEventHandlerUPP *resumeDispatchProc, long *refCon)
  1692. ;
  1693.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1694.         Macro
  1695.         _OSAGetResumeDispatchProc
  1696.             move.l              #$00080802,-(sp)
  1697.             moveq               #0,D0
  1698.             dc.w                $A82A
  1699.         EndM
  1700.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1701.         IMPORT_CFM_FUNCTION OSAGetResumeDispatchProc
  1702.     ENDIF
  1703.  
  1704. ; 
  1705. ;        OSAComponentFunctionInline(kOSASelectGetResumeDispatchProc, 8);
  1706. ;        Returns the registered ResumeDispatchProc.  If no ResumeDispatchProc has
  1707. ;        been registered, then kOSAUseStandardDispatch (the default) is returned.
  1708. ;    
  1709. ;        Errors:
  1710. ;            badComponentInstance    invalid scripting component instance
  1711. ;            errOSASystemError
  1712. ;    
  1713.  
  1714. ;
  1715. ; pascal OSAError OSAExecuteEvent(ComponentInstance scriptingComponent, const AppleEvent *theAppleEvent, OSAID contextID, long modeFlags, OSAID *resultingScriptValueID)
  1716. ;
  1717.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1718.         Macro
  1719.         _OSAExecuteEvent
  1720.             move.l              #$00100803,-(sp)
  1721.             moveq               #0,D0
  1722.             dc.w                $A82A
  1723.         EndM
  1724.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1725.         IMPORT_CFM_FUNCTION OSAExecuteEvent
  1726.     ENDIF
  1727.  
  1728. ; 
  1729. ;        OSAComponentFunctionInline(kOSASelectExecuteEvent, 16);
  1730. ;        This call is similar to OSAExecute except the initial command to
  1731. ;        execute comes in the form of an AppleEvent.  If the contextID
  1732. ;        defines any event handlers for that event, they are used to process
  1733. ;        the event.  If no event handler can be found in the context
  1734. ;        errAEEventNotHandled is returned.  If an event handler is found and
  1735. ;        the hander "continues" control onward, the ResumeDispatchProc
  1736. ;        (registered with OSASetResumeDispatchProc, above) is called given the
  1737. ;        AppleEvent.  The result is returned as a scriptValueID.
  1738. ;    
  1739. ;        Errors:
  1740. ;            badComponentInstance    invalid scripting component instance
  1741. ;            errOSASystemError
  1742. ;            errOSAInvalidID
  1743. ;            errOSAScriptError:        the executing script got an error
  1744. ;            errAEEventNotHandled:    no handler for event in contextID
  1745. ;    
  1746. ;        ModeFlags:
  1747. ;            kOSAModeNeverInteract
  1748. ;            kOSAModeCanInteract
  1749. ;            kOSAModeAlwaysInteract
  1750. ;            kOSAModeCantSwitchLayer
  1751. ;            kOSAModeDontReconnect
  1752. ;            kOSAModeDoRecord
  1753. ;    
  1754.  
  1755. ;
  1756. ; pascal OSAError OSADoEvent(ComponentInstance scriptingComponent, const AppleEvent *theAppleEvent, OSAID contextID, long modeFlags, AppleEvent *reply)
  1757. ;
  1758.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1759.         Macro
  1760.         _OSADoEvent
  1761.             move.l              #$00100804,-(sp)
  1762.             moveq               #0,D0
  1763.             dc.w                $A82A
  1764.         EndM
  1765.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1766.         IMPORT_CFM_FUNCTION OSADoEvent
  1767.     ENDIF
  1768.  
  1769. ; 
  1770. ;        OSAComponentFunctionInline(kOSASelectDoEvent, 16);
  1771. ;        This call is similar to OSADoScript except the initial command to
  1772. ;        execute comes in the form of an AppleEvent, and the result is an 
  1773. ;        AppleEvent reply record.  If the contextID defines any event handlers
  1774. ;        for that event, they are used to process the event.  If no event handler
  1775. ;        can be found in the context errAEEventNotHandled is returned.  If an
  1776. ;        event handler is found and the hander "continues" control onward, the
  1777. ;        ResumeDispatchProc (registered with OSASetResumeDispatchProc, above) is
  1778. ;        called given the AppleEvent.  The result is returned in the form of an
  1779. ;        AppleEvent reply descriptor. If at any time the script gets an error, or
  1780. ;        if the ResumeDispatchProc returns a reply event indicating an error,
  1781. ;        then the OSADoEvent call itself returns an error reply (i.e. OSADoEvent
  1782. ;        should never return errOSAScriptError).  Any error result returned by
  1783. ;        the ResumeDispatchProc will be returned by OSADoEvent.
  1784. ;    
  1785. ;        Errors:
  1786. ;            badComponentInstance    invalid scripting component instance
  1787. ;            errOSASystemError
  1788. ;            errOSAInvalidID
  1789. ;            errAEEventNotHandled:    no handler for event in contextID
  1790. ;    
  1791. ;        ModeFlags:
  1792. ;            kOSAModeNeverInteract
  1793. ;            kOSAModeCanInteract
  1794. ;            kOSAModeAlwaysInteract
  1795. ;            kOSAModeCantSwitchLayer
  1796. ;            kOSAModeDontReconnect
  1797. ;            kOSAModeDoRecord
  1798. ;    
  1799.  
  1800. ;
  1801. ; pascal OSAError OSAMakeContext(ComponentInstance scriptingComponent, const AEDesc *contextName, OSAID parentContext, OSAID *resultingContextID)
  1802. ;
  1803.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  1804.         Macro
  1805.         _OSAMakeContext
  1806.             move.l              #$000C0805,-(sp)
  1807.             moveq               #0,D0
  1808.             dc.w                $A82A
  1809.         EndM
  1810.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1811.         IMPORT_CFM_FUNCTION OSAMakeContext
  1812.     ENDIF
  1813.  
  1814. ; 
  1815. ;        OSAComponentFunctionInline(kOSASelectMakeContext, 12);
  1816. ;        Makes a new empty context which may be passed to OSAExecute or 
  1817. ;        OSAExecuteEvent.  If contextName is typeNull, an unnamed context is
  1818. ;        created. If parentContext is kOSANullScript then the resulting context
  1819. ;        does not inherit bindings from any other context.
  1820. ;    
  1821. ;        Errors:
  1822. ;            badComponentInstance    invalid scripting component instance
  1823. ;            errOSASystemError
  1824. ;            errOSAInvalidID
  1825. ;            errAECoercionFail:        contextName is invalid
  1826. ;    
  1827.  
  1828.  
  1829.     ENDIF ; __OSA__ 
  1830.  
  1831.